springboot中swagger、异步/定时/邮件任务的问题 |
您所在的位置:网站首页 › apiparam swagger › springboot中swagger、异步/定时/邮件任务的问题 |
springboot中swagger、异步/定时/邮件任务的问题 目录1、SpringBoot:集成Swagger终极版1.1、Swagger简介1.2、SpringBoot集成Swagger1.3、配置Swagger1.4、配置扫描接口1.5、配置Swagger开关1.6、配置API分组1.7、实体配置1.8、常用注解1.9、拓展:其他皮肤2、SpringBoot:异步、定时、邮件任务2.1、异步任务2.2、邮件任务2.3、定时任务 1、SpringBoot:集成Swagger终极版 学习目标: 了解Swagger的概念及作用 掌握在项目中集成Swagger自动生成API文档 1.1、Swagger简介 前后端分离 前端 -> 前端控制层、视图层 后端 -> 后端控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合 产生的问题 前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发 解决方案 首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险 Swagger 号称世界上最流行的API框架 Restful Api 文档在线自动生成器=> API 文档 与API 定义同步更新 直接运行,在线测试API 支持多种语言 (如:java,php等) 官网: 1.2、SpringBoot集成Swagger SpringBoot集成Swagger=> springfox,两个jar包 Springfox-swagger2 swagger-springmvc 使用Swagger 要求:jdk 1.8 + 否则swagger2无法运行 步骤: 1、新建一个SpringBoot-web项目 2、添加Maven依赖 io.springfox springfox-swagger-ui 3.0.0 io.springfox springfox-swagger2 3.0.0 3、编写HelloController,测试确保运行成功! 4、要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger @Configuration //配置类 @EnableSwagger2// 开启Swagger2的自动配置 public class SwaggerConfig { } 5、访问测试 : ,可以看到swagger的界面; 重要在于写 文档名和描述,即ApiInfo有参构造的前2个参数。 1.3、配置Swagger 1、Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。 //配置了swagger的docket的bean实例 @Bean public Docket getDocket(){ return new Docket(DocumentationType.SWAGGER_2); }2、可以通过apiInfo()属性配置文档信息 //配置文档信息 private ApiInfo apiInfo() { Contact contact=new Contact("联系人名字", "联系人访问链接", "联系人邮箱"); return new ApiInfo( "Swagger学习", // 标题 "学习演示如何配置Swagger", // 描述 "v1.0", // 版本 "组织链接", // 组织链接 contact, // 联系人信息 "Apach 2.0 许可", // 许可 "许可链接", // 许可连接 new ArrayList()// 扩展); } 3、Docket 实例关联上 apiInfo() @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()); } 4、重启项目,访问测试 看下效果; 1.4、配置扫描接口 1、构建Docket时通过select()方法配置怎么扫描接口。 @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("com.wei.swagger.controller")) .build();} 2、重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类 3、除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式: any() // 扫描所有,项目中的所有接口都会被扫描到 none() // 不扫描接口 // 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求 withMethodAnnotation(final Class extends Annotation> annotation) // 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口 withClassAnnotation(final Class extends Annotation> annotation) basePackage(final String basePackage) // 根据包路径扫描接口 4、除此之外,我们还可以配置接口扫描过滤 paths : //配置了swagger的docket的bean实例 @Bean public Docket getDocket(Environment environment){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(getApiInfo()) .select() //RequestHandlerSelectors配置要扫描接口的方式、 //basePackage 指定要让swagger扫描的包 //RequestHandlerSelectors 还有any 和none方法 //withClassAnnotation 只扫描类上有XX注解 //withMethodAnnotation 只扫描方法上有XX注解 .apis(RequestHandlerSelectors.basePackage("com.wei.swagger.controller")) //paths 过滤路径 .paths(PathSelectors.ant("/wei/**")) .build(); }5、这里的可选值还有 any() // 任何请求都扫描 none() // 任何请求都不扫描 regex(final String pathRegex) // 通过正则表达式控制 ant(final String antPattern) // 通过ant()控制 1.5、配置Swagger开关 1、通过enable()方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了 enable 链式编程 @Bean public Docket getDocket(Environment environment){ return new Docket(DocumentationType.SWAGGER_2) .enable(false)// 关闭swagger : false。 默认ture 开启 .apiInfo(getApiInfo()) .select() //RequestHandlerSelectors配置要扫描接口的方式、 //basePackage 指定要让swagger扫描的包 //RequestHandlerSelectors 还有any 和none方法 //withClassAnnotation 只扫描类上有XX注解 //withMethodAnnotation 只扫描方法上有XX注解 .apis(RequestHandlerSelectors.basePackage("com.wei.swagger.controller")) //paths 过滤路径 .paths(PathSelectors.ant("/wei/**")) .build(); }2、如何动态配置当项目处于test、dev环境时显示swagger,处于prod时不显示? @Bean public Docket getDocket(Environment environment){ Profiles profiles=Profiles.of("dev","test"); //dev or test System.out.println(profiles); //通过environment.acceptsProfiles(profiles) 判断是否处在自己设定的环境当中 boolean b=environment.acceptsProfiles(profiles); return new Docket(DocumentationType.SWAGGER_2) .enable(b)// 关闭swagger : false。 默认ture 开启 .apiInfo(getApiInfo()) .select() //RequestHandlerSelectors配置要扫描接口的方式、 //basePackage 指定要让swagger扫描的包 //RequestHandlerSelectors 还有any 和none方法 //withClassAnnotation 只扫描类上有XX注解 //withMethodAnnotation 只扫描方法上有XX注解 .apis(RequestHandlerSelectors.basePackage("com.wei.swagger.controller")) //paths 过滤路径 .paths(PathSelectors.ant("/wei/**")) .build(); }3、可以在项目中增加一个dev的配置文件查看效果! 4、也可以通过配置文件实现,只是界面显示不友好。 application.properties spring.profiles.active=prod application-dev.properties springfox.documentation.swagger-ui.enabled=true application-prod.properties springfox.documentation.swagger-ui.enabled=false 1.6、配置API分组 1、如果没有配置分组,默认是default。通过groupName()方法即可配置分组: @Bean public Docket docket(Environment environment) { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .groupName("group1") // 配置分组 // 省略配置....} 2、重启项目http://查看分组 3、如何配置多个分组?配置多个分组只需要配置多个docket即可: @Bean public Docket getDocket2(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group2"); } @Bean public Docket getDocket3(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group3"); }4、重启项目查看即可 1.7、实体配置 1、新建一个实体类 package com.wei.swagger.pojo; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; @ApiModel("user实体类") @Data public class User { @ApiModelProperty("用户名") private String username; @ApiModelProperty("密码") private String password;} 2、只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中: @RequestMapping(value="/user" , method=RequestMethod.POST) public User user(){ return new User(); }3、重启查看测试 注:并不是因为@ApiModel这个注解让实体显示在这里了,而是只要出现在接口方法的返回值上的实体都会显示在这里,而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。 @ApiModel为类添加注释 @ApiModelProperty为类属性添加注释 1.8、常用注解 Swagger的所有注解定义在io.swagger.annotations包下 下面列一些经常用到的,未列举出来的可以另行查阅说明: Swagger注解 简单说明 @Api(tags=“xxx模块说明”) 作用在模块类上 @ApiOperation(“xxx接口说明”) 作用在接口方法上 @ApiModel(“xxxPOJO说明”) 作用在模型类上:如VO、BO @ApiModelProperty(value=“xxx属性说明”,hidden=true) 作用在类方法和属性上,hidden设置为true可以隐藏该属性 @ApiParam(“xxx参数说明”) 作用在参数、方法和字段上,类似@ApiModelProperty 我们也可以给请求的接口配置一些注释 @ApiOperation("test请求") @RequestMapping(value="/test" , method=RequestMethod.GET) public String test(@ApiParam("名字") String name){ return "test "+name; }测试结果如下 给controller添加注释 @Api(tags="hello 控制器") public class HelloController { } 这样的话,可以给一些比较难理解的属性或者接口,增加一些配置信息,让人更容易阅读! 相较于传统的Postman或Curl方式测试接口,使用swagger简直就是傻瓜式操作,不需要额外说明文档(写得好本身就是文档)而且更不容易出错,只需要录入数据然后点击Execute,如果再配合自动化框架,可以说基本就不需要人为操作了。 Swagger是个优秀的工具,现在国内已经有很多的中小型互联网公司都在使用它,相较于传统的要先出Word接口文档再测试的方式,显然这样也更符合现在的快速迭代开发行情。当然了,提醒下大家在正式环境要记得关闭Swagger,一来出于安全考虑二来也可以节省运行时内存。 总结: 1、我们可以通过swagger给一些比较难理解的属性或者接口,增加注释信息 2、接口文档实时更新 3、可以在线测试 1.9、拓展:其他皮肤 我们可以导入不同的包实现不同的皮肤定义: 1、默认的 访问 io.springfox springfox-swagger-ui 2.9.2 2、bootstrap-ui 访问 com.github.xiaoymin swagger-bootstrap-ui 1.9.1 3、Layui-ui 访问 com.github.caspar-chen swagger-ui-layer 1.1.3 4、mg-ui 访问 com.zyplayer swagger-mg-ui 1.0.6 2、SpringBoot:异步、定时、邮件任务 2.1、异步任务 编写方法,假装正在处理数据,使用线程设置一些延时,模拟同步等待的情况; @Service public class AsyncService { public void hello(){ try { Thread.sleep(3000); } catch (InterruptedException e) { e.printStackTrace(); } System.out.println("业务进行中....");} } 3、编写controller包 4、编写AsyncController类 我们去写一个Controller测试一下 @RestController public class AsyncController { @Autowired AsyncService asyncService; @GetMapping("/hello") public String hello(){ asyncService.hello(); return "hello!!!ok!!!";} } 5、访问进行测试,3秒后出现hello!!!ok!!!,这是同步等待的情况。 问题:我们如果想让用户直接得到消息,就在后台使用多线程的方式进行处理即可,但是每次都需要自己手动去编写多线程的实现的话,太麻烦了,我们只需要用一个简单的办法,在我们的方法上加一个简单的注解即可,如下: 6、给hello方法添加@Async注解; //告诉Spring这是一个异步方法 @Async public void hello(){ try { Thread.sleep(3000);} catch (InterruptedException e) { e.printStackTrace();} System.out.println("业务进行中...."); } SpringBoot就会自己开一个线程池,进行调用!但是要让这个注解生效,我们还需要在主程序上添加一个注解@EnableAsync ,开启异步注解功能; @EnableAsync //开启异步注解功能 @SpringBootApplication public class SpringbootTaskApplication { public static void main(String[] args) { SpringApplication.run(SpringbootTaskApplication.class, args);} } 7、重启测试,网页瞬间响应,后台代码依旧执行! 无需等待AsyncService 的hello 方法走完,可以继续执行下面的语句。 2.2、邮件任务 邮件发送,在我们的日常开发中,也非常的多,Springboot也帮我们做了支持邮件发送需要引入spring-boot-start-mail SpringBoot 自动配置MailSenderAutoConfiguration 定义MailProperties内容,配置在application.yml中 自动装配JavaMailSender(实现类:JavaMailSenderImpl 来写代码) 测试邮件发送 测试: 1、引入pom依赖 org.springframework.boot spring-boot-starter-mail 2、查看自动配置类:MailSenderAutoConfiguration 这个类中存在bean,JavaMailSenderImpl 然后我们去看下配置文件 @ConfigurationProperties( prefix="spring.mail" ) public class MailProperties { private static final Charset DEFAULT_CHARSET; private String host; private Integer port; private String username; private String password; private String protocol="smtp"; private Charset defaultEncoding; private Map properties; private String jndiName; } 3、配置文件: spring.mail.password=你的163授权码 spring.mail.host=smtp.163.com 如果使用qq,需要配置sslspring.mail.properties.mail.smtp.ssl.enable=true 4、Spring单元测试 package com.wei; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.mail.SimpleMailMessage; import org.springframework.mail.javamail.JavaMailSenderImpl; import org.springframework.mail.javamail.MimeMessageHelper; import javax.mail.MessagingException; import javax.mail.internet.MimeMessage; import java.io.File; import java.io.IOException; @SpringBootTest class Springboot09TestApplicationTests { @Autowired JavaMailSenderImpl javaMailSender; @Test void contextLoads() { // 发送邮件 SimpleMailMessage mailMessage=new SimpleMailMessage(); mailMessage.setFrom("[email protected]"); mailMessage.setTo("[email protected]"); mailMessage.setSubject("subject2.."); mailMessage.setText("text2..."); javaMailSender.send(mailMessage); } @Test void contextLoads2() throws MessagingException, IOException { // 发送复杂的邮件 MimeMessage mimeMessage=javaMailSender.createMimeMessage(); // 组装 MimeMessageHelper helper=new MimeMessageHelper(mimeMessage,true); // true ,支持多组件 multipart helper.setSubject("subject"); helper.setText(" //附件 String fileName=this.getClass().getClassLoader().getResource("1.jpg").getPath(); // 获取resources下的绝对路径 helper.addAttachment("1.jpg", new File(fileName)); helper.addAttachment("2.jpg", new File(fileName)); helper.setFrom("[email protected]"); //发送 helper.setTo("[email protected]"); //接收 javaMailSender.send(mimeMessage); }} contextLoads 结果 contextLoads2 结果 查看邮箱,邮件接收成功! 我们只需要使用Thymeleaf进行前后端结合即可开发自己网站邮件收发功能了! 2.3、定时任务 项目开发中经常需要执行一些定时任务,比如需要在每天凌晨的时候,分析一次前一天的日志信息,Spring为我们提供了异步执行任务调度的方式,提供了两个接口。 TaskExecutor接口 TaskScheduler接口 两个注解: @EnableScheduling @Scheduled cron表达式参考: 测试步骤: 1、创建一个ScheduledService 我们里面存在一个hello方法,他需要定时执行,怎么处理呢? import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Service; @Service public class ScheduledService { //在一个特定的时间执行这个方法 @Scheduled(cron="秒 分 时 * * ?") public void hello(){ System.out.println("hello 执行了"); }} 2、这里写完定时任务之后,我们需要在主程序上增加@EnableScheduling 开启定时任务功能 @EnableAsync //开启异步注解功能 @EnableScheduling //开启基于注解的定时任务 @SpringBootApplication public class SpringbootTaskApplication { public static void main(String[] args) { SpringApplication.run(SpringbootTaskApplication.class, args);} } 3、表达式生成器 4、常用的表达式 (1)0/2 * * * * ? 表示每2秒 执行任务 (1)0 0/2 * * * ? 表示每2分钟 执行任务 (1)0 0 2 1 * ? 表示在每月的1日的凌晨2点调整任务 (2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业 (3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作 (4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点 (5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时 (6)0 0 12 ? * WED 表示每个星期三中午12点 (7)0 0 12 * * ? 每天中午12点触发 (8)0 15 10 ? * * 每天上午10:15触发 (9)0 15 10 * * ? 每天上午10:15触发 (10)0 15 10 * * ? 每天上午10:15触发 (11)0 15 10 * * ? 2005 2005年的每天上午10:15触发 (12)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发 (13)0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发 (14)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发 (15)0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发 (16)0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发 (17)0 15 10 ? * MON-FRI 周一至周五的上午10:15触发 (18)0 15 10 15 * ? 每月15日上午10:15触发 (19)0 15 10 L * ? 每月最后一日的上午10:15触发 (20)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发 (21)0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发 (22)0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |